Improve Oban plugin handler and fix error handling #195
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The main purpose of this patch is to introduce plugin aware attributes - mostly counts of processed jobs. Plugins cover all the offerings of Oban 2.15 and Oban Pro 1.0, the current versions at time of writing. While testing this in a real app, I've noticed issues with exception handlers for plugin. Decided to slip in this patch changes to both job and plugin event handlers to rely on standard :telemetry.span/3 attributes instead of :error key (which seems like an artifact of earlier versions).
|
I don't know anything about Oban plugins. @indrekj can you comment on this? @bryannaegele any thoughts? |
indrekj
reviewed
Aug 31, 2023
| ) | ||
| end | ||
| def handle_event(@plugin_start, _measurements, %{plugin: plugin} = metadata, _config) do | ||
| span_name = "#{inspect(plugin)} process" |
There was a problem hiding this comment.
Is the inspect intentional? It will add quotes around the plugin name.
There was a problem hiding this comment.
Actually no. This is an atom right, so there wouldn't be extra quotes.
indrekj
reviewed
Aug 31, 2023
| %{} | ||
| ) | ||
| attributes = %{ | ||
| "messaging.oban.plugin": inspect(plugin) |
There was a problem hiding this comment.
I don't understand why do we need inspect here
There was a problem hiding this comment.
Got it. This is an atom right, so there wouldn't be extra quotes.
There was a problem hiding this comment.
Maybe Atom.to_string() or "#{plugin}" would be more intuitive though
indrekj
reviewed
Aug 31, 2023
| } | ||
| end | ||
|
|
||
| defp plugin_work_attributes(%{plugin: Oban.Plugins.Reindexer}), do: %{} |
There was a problem hiding this comment.
could also remove this line and let it go to the default case
indrekj
approved these changes
Aug 31, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The main purpose of this patch is to introduce plugin aware attributes - mostly counts of processed jobs.
Plugins cover all the offerings of Oban 2.15 and Oban Pro 1.0, the current versions at time of writing.
While testing this in a real app, I've noticed issues with exception handlers for plugin. Decided to slip in this patch changes to both job and plugin event handlers to rely on standard :telemetry.span/3 attributes instead of :error key (which seems like an artifact of earlier versions).